<?php
/*****************************************************************************************
 * X2CRM Open Source Edition is a customer relationship management program developed by
 * X2Engine, Inc. Copyright (C) 2011-2013 X2Engine Inc.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 * 
 * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
 * California 95067, USA. or at email address contact@x2engine.com.
 * 
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 * 
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * X2Engine" logo. If the display of the logo is not reasonably feasible for
 * technical reasons, the Appropriate Legal Notices must display the words
 * "Powered by X2Engine".
 *****************************************************************************************/

/**
 * X2FlowAction that launches a campaign
 * 
 * @package X2CRM.components.x2flow.actions
 */
class X2FlowCampaignLaunch extends X2FlowAction {
	public $title = 'Launch Campaign';
	public $info = 'Immediately begin emailing contacts on the selected campaign';
	
	public function paramRules() {
		return array(
			'title' => Yii::t('studio',$this->title),
			'info' => Yii::t('studio',$this->info),
			'options' => array(
				array('name'=>'campaign','label'=>'Campaign','type'=>'link','linkType'=>'Campaign','linkSource'=>Yii::app()->controller->createUrl(
					CActiveRecord::model('Campaign')->autoCompleteSource
				)),
			));
	}
	
	public function execute(&$params) {
		$campaign = CActiveRecord::model('Campaign')->findByPk($this->config['options']['campaign']);
		if($campaign === null || ($campaign->launchDate != 0 && $campaign->launchDate < time()) || empty($campaign->subject))
			return false;
		
		if(!isset($campaign->list) || ($campaign->list->type == 'dynamic' && X2Model::model($campaign->list->modelName)->count($campaign->list->queryCriteria()) < 1))
			return false;
		
		// check if there's a template, and load that into the content field
		if($campaign->template != 0) {
			$template = X2Model::model('Docs')->findByPk($campaign->template);
			if(isset($template))
				$campaign->content = $template->text;
		}
		
		//Duplicate the list for campaign tracking, leave original untouched
		//only if the list is not already a campaign list
		if($campaign->list->type != 'campaign') {
			$newList = $campaign->list->staticDuplicate();
			if(!isset($newList))
				return false;
			
			$newList->type = 'campaign';
			if(!$newList->save())
				return false;
			$campaign->list = $newList;
			$campaign->listId = $newList->id;
		}

		$campaign->launchDate = time();
		return $campaign->save();
	}
}